Skip to content

Conversation

@ytdHuang
Copy link
Member

@ytdHuang ytdHuang commented May 15, 2025

Checklist

Thank you for contributing to QuantumToolbox.jl! Please make sure you have finished the following tasks before opening the PR.

  • Please read Contributing to Quantum Toolbox in Julia.
  • Any code changes were done in a way that does not break public API.
  • Appropriate tests were added and tested locally by running: make test.
  • Any code changes should be julia formatted by running: make format.
  • All documents (in docs/ folder) related to code changes were updated and able to build locally by running: make docs.
  • (If necessary) the CHANGELOG.md should be updated (regarding to the code changes) and built by running: make changelog.

Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.

Description

I remove all the unnecessary files since DocumenterVitepress.jl will copy from the template if we didn't specify them.

However, we still need to customize the following files for some reasons (I modify it after I copied from the newest template):

  • config.mts: to add tutorial, benchmarks links in the navbar; also, some settings for documentation markdown
  • style.css: remove the weird extra blur of our logo in home page

@ytdHuang ytdHuang added the Skip ChangeLog Skip changelog update check in PR label May 15, 2025
@ytdHuang ytdHuang marked this pull request as ready for review May 15, 2025 07:52
@lazarusA
Copy link

I had a similar issue, don't delete the semi-links just yet. (put them back). My guess is that we should do that after/before doing a new release, still experimenting with it 😄 .

@lazarusA
Copy link

and this one: https://github.com/qutip/QuantumToolbox.jl/tree/gh-pages/.github/workflows you should delete. Otherwise it overwrites your deploys, not good.

@ytdHuang
Copy link
Member Author

ytdHuang commented May 15, 2025

and this one: https://github.com/qutip/QuantumToolbox.jl/tree/gh-pages/.github/workflows you should delete. Otherwise it overwrites your deploys, not good.

Yes, I just delete it, thank you !

@ytdHuang
Copy link
Member Author

ytdHuang commented May 15, 2025

I had a similar issue, don't delete the semi-links just yet. (put them back). My guess is that we should do that after/before doing a new release, still experimenting with it 😄 .

Hmm, it is still not rendering correctly @@.

Do you have other idea ?

@ytdHuang
Copy link
Member Author

When I add the symbolic links back, it doesn't seem as the normal symbolic link in gh-pages (no right arrow icon of the file).

@ytdHuang ytdHuang requested a review from albertomercurio May 15, 2025 09:07
@lazarusA
Copy link

mmm... in my case I just reverted the offending commits: JuliaDataCubes/YAXArrays.jl@15a9a0d

@lazarusA
Copy link

regardless, something is off in your PR, because not even the docs are being build correctly, a missing base? custom domain? .... not sure what it is without going into all your changes.

@ytdHuang
Copy link
Member Author

ytdHuang commented May 15, 2025

regardless, something is off in your PR, because not even the docs are being build correctly, a missing base? custom domain? .... not sure what it is without going into all your changes.

what do you mean missing base ?

We do have a custom domain, our url link to the document will be: https://qutip.org/QuantumToolbox.jl/
so I add deploy_url = "qutip.org/QuantumToolbox.jl"
Is there anywhere else I should modify ?

@ytdHuang
Copy link
Member Author

Why do you think our docs is not rendered correctly ?

I can build it locally, and I didn't see any error in CI pipeline ?

@ytdHuang
Copy link
Member Author

Ok
I think the links have been fixed.
should be ready to merge

@ytdHuang ytdHuang merged commit d0dcc78 into main May 16, 2025
6 checks passed
@ytdHuang ytdHuang deleted the doc/vitepress branch June 13, 2025 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip ChangeLog Skip changelog update check in PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants